Skip to content

Added Package Management Process and linked it in Ports contributors documentation. #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 18, 2025

Conversation

ericbsd
Copy link
Member

@ericbsd ericbsd commented Jul 17, 2025

Summary by Sourcery

Introduce comprehensive documentation for GhostBSD's package management process and update contributor resources to reference it.

Documentation:

  • Add detailed documentation describing GhostBSD's three-tier package management process, including repository structure, package flow, configuration, and operational guidelines.
  • Link the new package management process documentation from the main ports contributor index.

@ericbsd ericbsd requested review from a team as code owners July 17, 2025 01:20
Copy link
Contributor

sourcery-ai bot commented Jul 17, 2025

Reviewer's Guide

This pull request introduces a new documentation page detailing GhostBSD's three-tier package management process and updates the ports contributor index to reference this new resource, clarifying repository roles and package flow for contributors and developers.

Flow diagram for GhostBSD's three-tier package repository system

flowchart LR
    A[Unstable Repository]
    B[Testing Repository]
    C[Stable Repository]
    D[Development]
    E[Community Testing]
    F[Production]

    A -- Independent Development --> D
    B -- Validation & Testing --> E
    C -- User Deployment --> F

    B -- After Testing --> C
    D -. No automatic flow .-> B
    D -. No automatic flow .-> C
    A -. No automatic flow .-> B
    A -. No automatic flow .-> C
    B -- Promotion after validation --> C
Loading

Flow diagram for package promotion and security updates

flowchart TD
    subgraph Testing Repository
        T1[Build Packages]
        T2[Community Validation]
        T3[Security Updates]
    end
    subgraph Stable Repository
        S1[Sync Successful Packages]
        S2[Expedited Security Sync]
    end

    T1 --> T2 --> S1
    T3 -- Expedited Validation --> S2
Loading

Flow diagram for FreeBSD release alignment in repositories

flowchart LR
    F1[New FreeBSD releng branch created]
    U[Unstable Repository]
    T[Testing Repository]
    S[Stable Repository]

    F1 --> U
    U -- Tracks new releng branch --> U
    T -- Continues with current stable --> T
    S -- Remains synced with Testing --> S
Loading

File-Level Changes

Change Details Files
Added comprehensive documentation for the package management process.
  • Created a new 'package-process.md' file describing the three-tier repository system (unstable, testing, stable).
  • Documented repository purposes, package flow, configuration, operational procedures, and historical context.
contributor/ports/package-process.md
Linked the new package management process documentation in the ports contributor index.
  • Added a link to 'package-process.md' in the 'index.md' for easy contributor access.
contributor/ports/index.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ericbsd - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@github-project-automation github-project-automation bot moved this from In Review to In Progress in Documentation Management Jul 17, 2025
@ericbsd ericbsd merged commit 9ccdb17 into master Jul 18, 2025
4 checks passed
@ericbsd ericbsd deleted the package-process branch July 18, 2025 00:22
@github-project-automation github-project-automation bot moved this from In Progress to Done in Documentation Management Jul 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants